home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / topusr10.zip / TOPUSR.DOC < prev    next >
Text File  |  1992-11-16  |  8KB  |  169 lines
  1.  
  2.                         TopUsers 1.00 for PCBOARD 14.5a
  3.                       By Jason Harmon, Pixel USA Computer
  4.                     1937-B Tully Rd. San Jose, CA 95122 USA
  5.                         BBS: (408) 993-9208, 9600 v.42
  6.  
  7.  
  8.     DEFINITIONS:
  9.     ------------
  10.     Us, We, or I  = Pixel USA Computer, Jason Harmon, or any employee of
  11.                     Pixel USA Computer.
  12.     You           = User of TopUsers
  13.     The program   = TopUsers (any version)
  14.  
  15.     DISCLAIMER:
  16.     -----------
  17.     This program has been tested on many BBS systems. The program does not,
  18.     in any way, write  to the 'USERS' file or any other  file on the system
  19.     except the specified bulletin file. If, by some act of God, your system
  20.     and/or data is damaged by the use of the program we will not be liable.
  21.     You will use  this program at your own  risk. If you do not  agree with
  22.     the terms, simply do not use the program.
  23.  
  24.     TERMS:
  25.     ------
  26.     You may use  the program for as long as  you want without registration.
  27.     If you want  to remove the 15 second delay  after program execution and
  28.     the "(UNREGISTERED)"  removed from the bulletin,  you must register the
  29.     program. The program may not be dissassembled and reverse engineered in
  30.     any  way.  If  so,  the  program  will  not  function.  The  program is
  31.     officially released as SHAREWARE.  It is not free.
  32.  
  33.     WHAT THE PROGRAM DOES:
  34.     ----------------------
  35.     This  program  will  create  a   bulletin  for  PCBOARD  14.5a  systems
  36.     displaying a  sorted list of users  based on number of  bytes uploaded,
  37.     number of bytes download, number of bytes downloaded with no uploads (a
  38.     file  leacher report)  and number  of times  on. All  bulletins can  be
  39.     created into one listing or bulletins can be individually created.
  40.  
  41.     This program will only work on PCBOARD 14.5a based systems in which the
  42.     'USERS' file has  not been encripted. If the  'USERS' file is encripted
  43.     the program will try to process it (and fail miserably).
  44.  
  45.     SYSTEM REQUIREMENTS:
  46.     --------------------
  47.     A computer, 286 or better.
  48.     PCBOARD 14.5a, any variety.
  49.     Hard drive.
  50.     Memory, at least 64k free.
  51.  
  52.     SETUP:
  53.     ------
  54.     1. Extract all files into a subdirectory of your choice.
  55.  
  56.     2. Use  a text  editor to  modify the  'TOPUSR.CFG' file  to suit  your
  57.        needs. The  comments inside the  file are self  explanitory for each
  58.        setting.
  59.  
  60.        It is important that you *DO NOT* add or delete any lines inside the
  61.        file. If you do program execution will be unpredictable.
  62.  
  63.        To make addition configuration files copy the 'TOPUSR.CFG' file to a
  64.        different filename.  Ex. C:\>COPY TOPUSR.CFG TOPUSR1.CFG
  65.  
  66.     3. Verify that  your path statement in  your 'AUTOEXEC.BAT' file points
  67.        to a directory that contains  the 'PCBOARD.DAT' file. This will most
  68.        like be already done for you.
  69.  
  70.     4. After  you have  modified all  the configuration  files to suit your
  71.        needs, the program is ready to run.
  72.  
  73.     TYPES OF REPORTS:
  74.     -----------------
  75.     Top Uploaders       This  will  create  a   list  of  users  sorted  in
  76.                         descending  order  based  on  the  number  of bytes
  77.                         uploaded.
  78.  
  79.     Top Downloaders     This  will do  the  same  as the  previous bulletin
  80.                         except sorting  will be based  on downloads instead
  81.                         of uploads.
  82.  
  83.     Top File Leachers   This will  also do the  same as the  first bulletin
  84.                         except  it  will  only  show  users  who  have  not
  85.                         uploaded any  bytes. This would be  goos to display
  86.                         as a login screen (make these leachers feel bad).
  87.  
  88.     Top Callers         This  will  create  a  list  of  users sorted by in
  89.                         descending order  based on the number  of times on.
  90.                         It will display other  items of information such as
  91.                         files uploaded, files download and last date on.
  92.  
  93.     NOTE: if  the number of  users you set  to include is  greater than the
  94.     actual number  of users that match  the criteria, the bulletin  will be
  95.     gracefully trunctated.
  96.  
  97.     COMMAND LINE OPTIONS:
  98.     ---------------------
  99.     Usage:
  100.  
  101.     TOPUSR [/?] [/F:FILENAME.CFG /NOUP /NODN /NOZB /NOCL]
  102.  
  103.     /?                  View help screen.
  104.  
  105.     /F:FILENAME.CFG     Specify  a  configuration  to  use  other  than the
  106.                         default  'TOPUSR.CFG'  file.  Specify  the  default
  107.                         configuration  file   if  it  is   in  a  different
  108.                         directory from where the program was run.
  109.  
  110.     /NOUP               Do not include top uploaders bulletin.
  111.  
  112.     /NODN               Do not include top downloaders in bulletin.
  113.  
  114.     /NOZB               Do not include zero byte uploaders in bulletin.
  115.  
  116.     /NOCL               Do not include top callers in bulletin.
  117.  
  118.     /BIOS               Use  BIOS screen  writes rather  than direct screen
  119.                         writes.  BIOS  screen  writes  will  slow  down the
  120.                         program execution,  but it is  compatible with more
  121.                         types of video cards.
  122.  
  123.     You can include any number of options  on the command line. They can be
  124.     uppercase  or lowercase  and in  any  order.  If you  include the  '/?'
  125.     option, all other options will be ignored.
  126.  
  127.     If your copy has not been registered, you will see a 30 second delay at
  128.     the end of a successful program run.
  129.  
  130.     NETWORK USE:
  131.     ------------
  132.     The program  will operate safely  on any NETBIOS  compatible networking
  133.     system. If  the bulletin file  is being viewed  by a user,  the program
  134.     will retry  a certain number  of times  to  open file file  and wait an
  135.     interval of time between each retry.  You may set the maximum number of
  136.     retries  and the  interval time  in the  setup program.  If the maximum
  137.     number  of retries  is reached  the program  will terminate  and return
  138.     control to DOS.
  139.  
  140.     PROGRAM LIMITS:
  141.     ---------------
  142.     The program has an internal limitation  of 999 entries in the bulletin.
  143.     Other limits  of the program  are the same  limits set by  PCBOARD. For
  144.     example, it  will count the bumber  of bytes somewhere around  1.4GB (I
  145.     doubt you will  ever see this limit reached). Also,  up to 32,768 users
  146.     can be processed without running out of memory.
  147.  
  148.     PROGRAM EXECUTION SPEED:
  149.     ------------------------
  150.     The speed will be faster than  any other similar bulletin generator. On
  151.     my  386-33MHz with  950 users  and 15  users included  in the  bulletin
  152.     program execution  is 5 seconds. When  the program is finished  it will
  153.     display the  total elapsed time  (in seconds) so  you can compare  your
  154.     speed with mine.
  155.  
  156.     IF YOU WANT TO REGISTER:
  157.     ------------------------
  158.     You may  send a check  for $10 payable  to "Pixel USA  Computer" to the
  159.     address at the top of this form. Please let us know exactly the name of
  160.     your BBS  (the program generates a  number based on your  BBS name). We
  161.     will call or send to you your registration code.
  162.  
  163.     HOW TO REPORT PROBLEMS:
  164.     -----------------------
  165.     Please  call the  BBS number  listed above  and (C)omment  to the sysop
  166.     regarding  any problems.  We will  do the  best we  can to  resolve the
  167.     problem  in a  timely manner.  I am  a very  busy person  so don't  get
  168.     discouraged if I don't respond immediately.
  169.